/*
 * Copyright 2000-2019 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.ide.fileTemplates;

import com.intellij.ide.IdeBundle;
import com.intellij.openapi.extensions.ExtensionPointName;
import com.intellij.openapi.project.Project;
import com.intellij.psi.PsiDirectory;
import com.intellij.psi.PsiElement;
import com.intellij.util.IncorrectOperationException;
import org.jetbrains.annotations.Nls;
import org.jetbrains.annotations.NotNull;

import java.util.Map;

/**
 * @author yole
 */
public interface CreateFromTemplateHandler {
  ExtensionPointName<CreateFromTemplateHandler> EP_NAME = ExtensionPointName.create("com.intellij.createFromTemplateHandler");

  boolean handlesTemplate(@NotNull FileTemplate template);

  @NotNull
  PsiElement createFromTemplate(@NotNull Project project,
                                @NotNull PsiDirectory directory,
                                String fileName,
                                @NotNull FileTemplate template,
                                @NotNull String templateText,
                                @NotNull Map<String, Object> props) throws IncorrectOperationException;

  boolean canCreate(PsiDirectory @NotNull [] dirs);

  boolean isNameRequired();

  @NotNull
  @Nls(capitalization = Nls.Capitalization.Title)
  String getErrorMessage();

  void prepareProperties(@NotNull Map<String, Object> props);

  default void prepareProperties(@NotNull Map<String, Object> props, String fileName, @NotNull FileTemplate template) {}

  @NotNull
  @Nls(capitalization = Nls.Capitalization.Title)
  default String commandName(@NotNull FileTemplate template) {
    return IdeBundle.message("command.create.file.from.template");
  }
}